<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>experimental::await_token</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="executor_work_guard/_executor_work_guard.html" title="executor_work_guard::~executor_work_guard">
<link rel="next" href="experimental__await_token/await_token.html" title="experimental::await_token::await_token">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="executor_work_guard/_executor_work_guard.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="experimental__await_token/await_token.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.experimental__await_token"></a><a class="link" href="experimental__await_token.html" title="experimental::await_token">experimental::await_token</a>
</h3></div></div></div>
<p>
        A completion token that represents the currently executing coroutine.
      </p>
<pre class="programlisting">template&lt;
    typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a>&gt;
class await_token
</pre>
<h5>
<a name="asio.reference.experimental__await_token.h0"></a>
        <span><a name="asio.reference.experimental__await_token.types"></a></span><a class="link" href="experimental__await_token.html#asio.reference.experimental__await_token.types">Types</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody><tr>
<td>
                <p>
                  <a class="link" href="experimental__await_token/executor_type.html" title="experimental::await_token::executor_type"><span class="bold"><strong>executor_type</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  The associated executor type.
                </p>
              </td>
</tr></tbody>
</table></div>
<h5>
<a name="asio.reference.experimental__await_token.h1"></a>
        <span><a name="asio.reference.experimental__await_token.member_functions"></a></span><a class="link" href="experimental__await_token.html#asio.reference.experimental__await_token.member_functions">Member
        Functions</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <a class="link" href="experimental__await_token/await_token.html" title="experimental::await_token::await_token"><span class="bold"><strong>await_token</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Copy constructor. <br> <span class="silver"> &#8212;</span><br> Move constructor.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="experimental__await_token/get_executor.html" title="experimental::await_token::get_executor"><span class="bold"><strong>get_executor</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Get the associated executor.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<p>
        The <a class="link" href="experimental__await_token.html" title="experimental::await_token"><code class="computeroutput">experimental::await_token</code></a>
        class is used to represent the currently executing coroutine. An <a class="link" href="experimental__await_token.html" title="experimental::await_token"><code class="computeroutput">experimental::await_token</code></a>
        may be passed as a handler to an asynchronous operation. For example:
      </p>
<pre class="programlisting">awaitable&lt;void&gt; my_coroutine()
{
  await_token token = co_await this_coro::token();
  ...
  std::size_t n = co_await my_socket.async_read_some(buffer, token);
  ...
}
</pre>
<p>
        The initiating function (async_read_some in the above example) suspends the
        current coroutine. The coroutine is resumed when the asynchronous operation
        completes, and the result of the operation is returned.
      </p>
<h5>
<a name="asio.reference.experimental__await_token.h2"></a>
        <span><a name="asio.reference.experimental__await_token.requirements"></a></span><a class="link" href="experimental__await_token.html#asio.reference.experimental__await_token.requirements">Requirements</a>
      </h5>
<p>
        <span class="emphasis"><em>Header: </em></span><code class="literal">asio/experimental/co_spawn.hpp</code>
      </p>
<p>
        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio/experimental.hpp</code>
      </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2003-2018 Christopher M. Kohlhoff<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="executor_work_guard/_executor_work_guard.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="experimental__await_token/await_token.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>
